package com.example.vue_shop.config.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author lipengwei
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 创建APi的基本信息.
     * @return ApiInfo
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // swagger 的标题
                .title("Vue_shop_boot")
                // swagger 中 对项目的描述
                .description("配合前端项目的springboot服务。")
                // 项目的访问地址
                .termsOfServiceUrl("http://127.0.0.1:8081/doc.html")
                .contact("lipengwei")
                // 项目版本号
                .version("1.0")
                .build();
    }

    /**
     创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     * @return
     */
    @Bean
    public Docket creatRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.vue_shop.components"))
                .paths(PathSelectors.any()).build();
    }


}
